Standardize on using dune to build CodeHawk by brk · Pull Request #196 · static-analysis-engineering/codehawk

brk · 2025-05-02T20:28:30Z

Also remove the Shake-based build (even though it's a great example!).

Remove the Shake-based build (even though it's a great example!).

waskyo · 2025-05-03T13:46:31Z

CodeHawk/README.md

-~/.cabal/bin/shake
-```
+# Run with sudo if you wish to install globally
+bash -c "sh <(curl -fsSL https://opam.ocaml.org/install.sh)"


apt-get install opam should work in 22.04?

https://packages.ubuntu.com/jammy/opam

Better to keep the instructions as OS-neutral as possible?

waskyo · 2025-05-03T13:47:55Z

CodeHawk/README.md

-### Homebrew
+sudo apt install --no-install-recommends software-properties-common \
+                     build-essential unzip \
+                     pkg-config m4 zlib1g-dev libgmp-dev bubblewrap -y


some questions/comments:

I think software-properties-common was only needed to add the opam ppa.

what do we need bubblewrap for?

could this be missing the jdk dependency to open the jar summary files? (we really should replace that with zip).

Ah, could be!

Opam uses bubblewrap to sandbox the builds it runs so that buggy shell scripts do not inadvertently rm -rf ~/

The prior instructions bypass the bwrap dependency via --no-sandboxing but that seems... not the right guidance to be giving without clear justification.

Re: jar files, one of the libraries CodeHawk depends on is camlzip, I'm not sure if it's already used for jar files though.

CodeHawk-Binary depends on literally the jar executable from the JDK, though it uses it to make regular zip files that are interpreted by camlzip in this project as you mention and not any actual JRE.

waskyo · 2025-05-03T13:49:18Z

CodeHawk/README.md

-/path/to/shake
-```
+Dependencies for other OS flavors:
+- Arch Linux: `sudo pacman -Syu opam`


it seems like the extra deps from the other distros should also go in here? #untested

Maybe we should remove the instructions for other OS flavors? I haven't tested them.

waskyo · 2025-05-03T13:49:28Z

CodeHawk/README.md

-```
+Dependencies for other OS flavors:
+- Arch Linux: `sudo pacman -Syu opam`
+- Fedora: `sudo yum install opam diffutils zlib-devel ocaml-lablgtk-devel -y`


chances are you don't need the gtk package, that sounds like a GUI thing

Databean

Thanks!

Databean · 2025-05-17T22:42:42Z

CodeHawk/README.md

-### Homebrew
+sudo apt install --no-install-recommends software-properties-common \
+                     build-essential unzip \
+                     pkg-config m4 zlib1g-dev libgmp-dev bubblewrap -y


CodeHawk-Binary depends on literally the jar executable from the JDK, though it uses it to make regular zip files that are interpreted by camlzip in this project as you mention and not any actual JRE.

Databean · 2025-05-17T22:47:02Z

CodeHawk/README.md

-### Arch Linux
+opam switch create . 5.2.0
+eval $(opam env)
+opam install dune ocamlfind zarith camlzip extlib goblint-cil.2.0.6


What makes it necessary to pin goblint-cil at a specific version while leaving the others at arbitrary versions?

goblint-cil has released API-incompatible changes in point version bumps... I think three times in the last two years?

CodeHawk's other dependencies have remained API-stable, so there is no particular reason to pin them.

Databean · 2025-05-17T22:54:37Z

CodeHawk/README.md

-/path/to/shake
-```
+Dependencies for other OS flavors:
+- Arch Linux [untested]: `sudo pacman -Syu opam`


For completeness this should be sudo pacman -Syu base-devel git opam

Validated with

$ sudo docker run -it --rm archlinux bash $ pacman -Syu base-devel git opam

then the rest of the instructions.

Thank you for doing this testing!

Databean · 2025-05-17T23:02:53Z

CodeHawk/README.md

-```
+Dependencies for other OS flavors:
+- Arch Linux [untested]: `sudo pacman -Syu opam`
+- Fedora [untested]: `sudo yum install opam diffutils zlib-devel -y`


For completeness this should be sudo yum install awk diffutils git gmp-devel opam perl-ExtUtils-MakeMaker perl-FindBin perl-Pod-Html zlib-devel -y

Validated with

$ sudo docker run -it --rm fedora bash $ yum install awk diffutils git gmp-devel opam perl-ExtUtils-MakeMaker perl-FindBin perl-Pod-Html zlib-devel -y

then the rest of the instructions.

Databean · 2025-05-17T23:06:14Z

CodeHawk/README.md

-opam install ocamlfind zarith camlzip extlib lablgtk lablgtk-extras
-/path/to/shake
-```
+Dependencies for other OS flavors:


Rather than organizing the page as

Dependencies (assuming Debian/Ubuntu)

Install instructions

Dependencies (other distros)

can the page use collapsed sections to group all the operating system / distro instructions together without taking up too much space? That doesn't favor any operating system or distribution in particular.

Databean · 2025-05-17T23:21:00Z

CodeHawk/README.md

-2. Install the shake build system
-3. Install ocaml
-4. Build CodeHawk
+sudo apt install --no-install-recommends \


On the latest Debian there is no openjdk-21-jdk, and this additionally needs ca-certificates and git.

Validated with

$ sudo docker run -it --privileged --rm debian bash $ apt update -y $ apt install --no-install-recommends build-essential opam unzip ca-certificates git pkg-config m4 zlib1g-dev libgmp-dev bubblewrap -y

then the rest of the instructions.

--privileged was necessary for bubblewrap to work.

I guess the previous instructions had been giving instructions for users who presumably already have git installed, rather than brave souls running commands in fresh containers :-) But on balance I think you are right, it's better to err on the side of giving reproducible instructions rather than minimal instructions.

Re openjdk-21-jdk you are indeed correct, it seems to be an Ubuntu-ism. I'll switch the instructions to use default-jdk which works on both Ubuntu and Debian.

Databean · 2025-05-17T23:29:35Z

CodeHawk/README.md

-2. Install the shake build system
-3. Install ocaml
-4. Build CodeHawk
+sudo apt install --no-install-recommends \


On the latest Ubuntu this also should include git, for completeness.

Validated with

$ sudo docker run -it --privileged --rm ubuntu bash $ apt update -y $ apt install --no-install-recommends build-essential git opam unzip openjdk-21-jdk pkg-config m4 zlib1g-dev libgmp-dev bubblewrap -y

then the rest of the instructions.

--privileged was necessary for bubblewrap to work.

Standardize on using dune to build CodeHawk

bec181d

Remove the Shake-based build (even though it's a great example!).

waskyo reviewed May 3, 2025

View reviewed changes

Standardize on dune build @install

affb898

Databean approved these changes May 17, 2025

View reviewed changes

Address feedback from @Databean

5d6c98f

brk force-pushed the standardize-on-dune branch from d711c13 to 5d6c98f Compare May 19, 2025 01:57

Pin goblint-cil.2.0.6 in CI

25e2701

Databean merged commit a882fc5 into static-analysis-engineering:master May 31, 2025
24 checks passed

brk deleted the standardize-on-dune branch September 25, 2025 19:23

Conversation

brk commented May 2, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Databean left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants